Carbon Compose/com.gabrieldrn.carbon.progressbar

Package-level declarations

Types

enum ProgressBarSize : Enum<ProgressBarSize>

The ProgressBar is offered in two different sizes—big (8px) and small (4px). The big progress bar height is typically used when there is large amounts of space on a page. The small progress bar height is commonly used when space is restricted and can be placed within cards, data tables, or side panels.

ProgressBarState

@Immutable

enum ProgressBarState : Enum<ProgressBarState>

There are three states for the progress bar: active, success, and error. These states also apply on both indeterminate and determinate progress bars. After the process completes successfully or unsuccesfully, a progress bar can either remain persistent as confirmation or validation, or it can be automatically dismissed depending on what is most suitable for the use case.

Functions

IndeterminateProgressBar

@Composable

fun IndeterminateProgressBar(modifier: Modifier = Modifier, labelText: String? = null, helperText: String? = null, indented: Boolean = false, inlined: Boolean = false, state: ProgressBarState = ProgressBarState.Active, size: ProgressBarSize = ProgressBarSize.Big)

A progress bar provides feedback about the duration and progression of a process, such as a download, file transfer, or installation, to indicate how long a user will be waiting.

ProgressBar

@Composable

fun ProgressBar(value: Float, modifier: Modifier = Modifier, labelText: String? = null, helperText: String? = null, indented: Boolean = false, inlined: Boolean = false, state: ProgressBarState = ProgressBarState.Active, size: ProgressBarSize = ProgressBarSize.Big)

A progress bar provides feedback about the duration and progression of a process, such as a download, file transfer, or installation, to indicate how long a user will be waiting.